Vcenter Lcm Deployment Common ApplianceDeployment

The Vcenter Lcm Deployment Common ApplianceDeployment schema describes the new appliance deployment configuration.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "name": "string",
    "size": "string",
    "thin_disk_mode": false,
    "disk_size": "string",
    "root_password": "string",
    "network_settings": {
        "ip_family": "string",
        "mode": "string",
        "ip": "string",
        "dns_servers": [
            "string"
        ],
        "prefix": 0,
        "gateway": "string",
        "hostname": "string"
    },
    "ova_info": {
        "location": "string",
        "ssl_verify": false,
        "ova_checksum": "string",
        "ova_checksum_algorithm": "string",
        "certificate": "string"
    },
    "ceip_enabled": false,
    "cpu_allocation": {
        "reservation": 0,
        "allocate": "string"
    },
    "memory_allocation": {
        "reservation": 0,
        "allocate": "string"
    }
}

string

name

Optional

The VM name of the appliance to deploy.

This property was added in vSphere API 9.0.0.0.

If name is not specified, default VM name will be used with following format: vcenter-upgrade-[upgrade-uuid].

string

size

Optional

A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance.

For more information see: Vcenter Lcm Deployment Common ApplianceSize.

This property was added in vSphere API 9.0.0.0.

If size is not provided, will use the size of the source VCSA

boolean

thin_disk_mode

Optional

Whether to deploy the appliance with thin mode virtual disks.

This property was added in vSphere API 9.0.0.0.

If missing or null, the source vCenter disk deployment will be tried. If there is no information provided for the source container a default value of thin deployment will be set.

string

disk_size

Optional

The disk size of the new vCenter appliance.

For more information see: Vcenter Lcm Deployment Common StorageSize.

This property was added in vSphere API 9.0.0.0.

If disk_size is not provided, will use the diskSize of the source VCSA.

string As password As password

root_password

Required

A root password to be used for that appliance. During migration upgrade it is only temporary passwords. It must conform to the following requirements:

At least 8 characters.
No more than 20 characters.
At least 1 uppercase character.
At least 1 lowercase character.
At least 1 number.
At least 1 special character (e.g., '!', '(', '@', etc.).
Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)

This property was added in vSphere API 9.0.0.0.

network_settings

Optional

The network settings of the appliance to be deployed.

This property was added in vSphere API 9.0.0.0.

If missing or null the appliance will be deployed with an automatically selected link-local address.

ova_info

Optional

Custom location of the OVA for deployment.

This property was added in vSphere API 9.0.0.0.

If missing or null use the OVA file for the desired version in the configured repository.

boolean

ceip_enabled

Optional

This key describes the enabling option for the VMware's Customer Experience Improvement Program (CEIP).

This property was added in vSphere API 9.0.0.0.

If missing or null, defaults to True

cpu_allocation

Optional

Resource allocation information of CPU.

This property was added in vSphere API 9.0.0.0.

If missing or null will deploy the appliance with no cpu reservation.

memory_allocation

Optional

Resource allocation information of Memory

This property was added in vSphere API 9.0.0.0.

If missing or null will deploy the appliance with no memory reservation.